Vcenter VmTemplate LibraryItems HardwareCustomizationSpec

The Vcenter VmTemplate LibraryItems HardwareCustomizationSpec schema defines the hardware customization options that are applied to the deployed virtual machine.

This schema was added in vSphere API 6.8.

JSON Example

{
    "nics": {
        "nics": {
            "network": "string"
        }
    },
    "disks_to_remove": [
        "string"
    ],
    "disks_to_update": {
        "disks_to_update": {
            "capacity": 0
        }
    },
    "cpu_update": {
        "num_cpus": 0,
        "num_cores_per_socket": 0
    },
    "memory_update": {
        "memory": 0
    }
}

object

nics

Optional

Map of Ethernet network adapters to update.

This property was added in vSphere API 6.8.

If missing or null, all Ethernet adapters will remain connected to the same network as they were in the source virtual machine template. An Ethernet adapter with a MacAddressType of MANUAL will not change. An Ethernet adapter with a MacAddressType of GENERATED or ASSIGNED will receive a new address.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

array of string

disks_to_remove

Optional

Idenfiers of disks to remove from the deployed virtual machine.

This property was added in vSphere API 6.8.

If missing or null, all disks will be copied.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.

object

disks_to_update

Optional

Disk update specification for individual disks in the deployed virtual machine.

This property was added in vSphere API 6.8.

If missing or null, disks in the deployed virtual machine will have the same settings as the corresponding disks in the source virtual machine template contained in the library item.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

cpu_update

Optional

CPU update specification for the deployed virtual machine.

This property was added in vSphere API 6.8.

If missing or null, the deployed virtual machine has the same CPU settings as the source virtual machine template contained in the library item.

memory_update

Optional

Memory update specification for the deployed virtual machine.

This property was added in vSphere API 6.8.

If missing or null, the deployed virtual machine has the same memory settings as the source virtual machine template contained in the library item.